|
Foxit PDF SDK
|
Inherits FoxitPDFSDKPython3._object.
Public Member Functions | |
| def | DWG2PDFSettingData () |
| Constructor, with parameters. | |
Static Public Attributes | |
| background_color_index = _fsdk.DWG2PDFSettingData_background_color_index | |
| Background color index in the CAD color palette (range: [0-255]). More... | |
| color_image_output_dpi = _fsdk.DWG2PDFSettingData_color_image_output_dpi | |
| Color image output DPI setting. More... | |
| color_policy = _fsdk.DWG2PDFSettingData_color_policy | |
| The color policy used for the converted PDF document. More... | |
| drawing_size_block_reference_name = _fsdk.DWG2PDFSettingData_drawing_size_block_reference_name | |
| The Name of the block reference used to compute drawing scale. More... | |
| e_DWG2PDFColorPolicyGrayscale = _fsdk.DWG2PDFSettingData_e_DWG2PDFColorPolicyGrayscale | |
| Color policy: Drawing is exported to a grayscale PDF file. Native colors are converted into grayscale. | |
| e_DWG2PDFColorPolicyIndexToBlack = _fsdk.DWG2PDFSettingData_e_DWG2PDFColorPolicyIndexToBlack | |
| Color policy: Index colors are converted to black, while all other colors keep their object colors. | |
| e_DWG2PDFColorPolicyMono = _fsdk.DWG2PDFSettingData_e_DWG2PDFColorPolicyMono | |
| Color policy: Drawing is exported to a monochrome PDF file. | |
| e_DWG2PDFColorPolicyNoPolicy = _fsdk.DWG2PDFSettingData_e_DWG2PDFColorPolicyNoPolicy | |
| Color policy: No color policy. A drawing is exported with its native color palette (as is). | |
| e_DWG2PDFExportHatchesTypeBitmap = _fsdk.DWG2PDFSettingData_e_DWG2PDFExportHatchesTypeBitmap | |
| Hatches export type: Exports hatch as a bitmap. | |
| e_DWG2PDFExportHatchesTypeDrawing = _fsdk.DWG2PDFSettingData_e_DWG2PDFExportHatchesTypeDrawing | |
| Hatches export type: Exports hatch as a set of triangles (vectorizer). | |
| e_DWG2PDFExportHatchesTypePdfPaths = _fsdk.DWG2PDFSettingData_e_DWG2PDFExportHatchesTypePdfPaths | |
| Hatches export type: Exports hatch as a PDF path (solid hatches only). | |
| e_DWG2PDFExportHatchesTypePolygons = _fsdk.DWG2PDFSettingData_e_DWG2PDFExportHatchesTypePolygons | |
| Hatches export type: Exports hatch as a polygon (solid hatches only). | |
| e_DWG2PDFLayoutScopeAllLayouts = _fsdk.DWG2PDFSettingData_e_DWG2PDFLayoutScopeAllLayouts | |
| Export all layouts. | |
| e_DWG2PDFLayoutScopeAutoByLayoutOverflow = _fsdk.DWG2PDFSettingData_e_DWG2PDFLayoutScopeAutoByLayoutOverflow | |
| Auto-select layouts or model space based on viewport overflow check. | |
| e_DWG2PDFLayoutScopeAutoRects = _fsdk.DWG2PDFSettingData_e_DWG2PDFLayoutScopeAutoRects | |
| Auto-detect and export multiple rectangles in model space. | |
| e_DWG2PDFLayoutScopeAutoRectsAndAllLayouts = _fsdk.DWG2PDFSettingData_e_DWG2PDFLayoutScopeAutoRectsAndAllLayouts | |
| Merge results of FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLayoutScopeAutoRects and FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLayoutScopeAllLayouts into one PDF. | |
| e_DWG2PDFLayoutScopeCurrentLayout = _fsdk.DWG2PDFSettingData_e_DWG2PDFLayoutScopeCurrentLayout | |
| Export current layout. | |
| e_DWG2PDFLayoutScopeDrawingLimits = _fsdk.DWG2PDFSettingData_e_DWG2PDFLayoutScopeDrawingLimits | |
| Export drawing limits. | |
| e_DWG2PDFLayoutScopeFrameBlocks = _fsdk.DWG2PDFSettingData_e_DWG2PDFLayoutScopeFrameBlocks | |
| Export configured frame blocks in model space as multiple PDF pages. More... | |
| e_DWG2PDFLayoutScopeLayoutByIndex = _fsdk.DWG2PDFSettingData_e_DWG2PDFLayoutScopeLayoutByIndex | |
| Export a specific layout by index, specified by DWG2PDFSettingData::layout_index. | |
| e_DWG2PDFLayoutScopeModelSpaceAndLayouts = _fsdk.DWG2PDFSettingData_e_DWG2PDFLayoutScopeModelSpaceAndLayouts | |
| Export model space and all valid layouts. | |
| e_DWG2PDFLayoutScopeModelSpaceOnly = _fsdk.DWG2PDFSettingData_e_DWG2PDFLayoutScopeModelSpaceOnly | |
| Export model space only. | |
| e_DWG2PDFLineweightStyleModeNoStyleNoLineweight = _fsdk.DWG2PDFSettingData_e_DWG2PDFLineweightStyleModeNoStyleNoLineweight | |
| Ignore plot style and lineweight. | |
| e_DWG2PDFLineweightStyleModeStyleAndLineweight = _fsdk.DWG2PDFSettingData_e_DWG2PDFLineweightStyleModeStyleAndLineweight | |
| Enable plot style and lineweight. | |
| e_DWG2PDFLineweightStyleModeStyleNoLineweight = _fsdk.DWG2PDFSettingData_e_DWG2PDFLineweightStyleModeStyleNoLineweight | |
| Enable plot style and ignore lineweight. | |
| e_DWG2PDFSearchableTextTypeNoSearch = _fsdk.DWG2PDFSettingData_e_DWG2PDFSearchableTextTypeNoSearch | |
| Searchable text type: No searchable text. | |
| e_DWG2PDFSearchableTextTypeSHX = _fsdk.DWG2PDFSettingData_e_DWG2PDFSearchableTextTypeSHX | |
| Searchable text type: Only text displayed with SHX font is searchable. | |
| e_DWG2PDFSearchableTextTypeTTF = _fsdk.DWG2PDFSettingData_e_DWG2PDFSearchableTextTypeTTF | |
| Searchable text type: Only text displayed with TTF font is searchable. | |
| e_FlagASCIIHexEncoding = _fsdk.DWG2PDFSettingData_e_FlagASCIIHexEncoding | |
| Bit 10. Enable ASCIIHex encoding of internal PDF streams. | |
| e_FlagEmbededOptimizedTTF = _fsdk.DWG2PDFSettingData_e_FlagEmbededOptimizedTTF | |
| Bit 7. Enable embedding of TTF font program to PDF file. The TTF font will be reduced by removing unused parts (smaller PDF file size, but limited editing). | |
| e_FlagEmbededTTF = _fsdk.DWG2PDFSettingData_e_FlagEmbededTTF | |
| Bit 1. Enable embedding of TTF(True Type Font) program to PDF file. The whole TTF font file will be embedded (huge PDF size). | |
| e_FlagEnableLayers = _fsdk.DWG2PDFSettingData_e_FlagEnableLayers | |
| Bit 5. If enabled, layer support will be added to PDF file (1.5 version required). | |
| e_FlagExportHyperlinks = _fsdk.DWG2PDFSettingData_e_FlagExportHyperlinks | |
| Bit 11. Enable hyperlinks export. | |
| e_FlagFlateCompression = _fsdk.DWG2PDFSettingData_e_FlagFlateCompression | |
| Bit 9. Enable compression of internal PDF streams. | |
| e_FlagIncludeOffLayers = _fsdk.DWG2PDFSettingData_e_FlagIncludeOffLayers | |
| Bit 6. If enabled, invisible layers will be added to PDF file (1.5 version required). | |
| e_FlagLinearized = _fsdk.DWG2PDFSettingData_e_FlagLinearized | |
| Bit 13. Create linearized PDF file. | |
| e_FlagMeasuring = _fsdk.DWG2PDFSettingData_e_FlagMeasuring | |
| Bit 15. Enable measuring scale in pdf. | |
| e_FlagSHXTextAsGeometry = _fsdk.DWG2PDFSettingData_e_FlagSHXTextAsGeometry | |
| Bit 3. Enable SHX font text to geometry conversion. | |
| e_FlagSimpleGeomOptimization = _fsdk.DWG2PDFSettingData_e_FlagSimpleGeomOptimization | |
| Bit 4. Enable simple geometry optimization (separated segments to one polyline, Bezier curve control points). | |
| e_FlagTTFTextAsGeometry = _fsdk.DWG2PDFSettingData_e_FlagTTFTextAsGeometry | |
| Bit 2. Enable TTF font text to geometry conversion. | |
| e_FlagUseHLR = _fsdk.DWG2PDFSettingData_e_FlagUseHLR | |
| Bit 8. Determines whether software uses vector hidden-line removal for corresponding viewports. | |
| e_FlagZoomToExtentsMode = _fsdk.DWG2PDFSettingData_e_FlagZoomToExtentsMode | |
| Bit 12. If enabled, layout geometry will be zoomed to paper size, else layout settings will be applied. More... | |
| enable_diagnostic_log_output = _fsdk.DWG2PDFSettingData_enable_diagnostic_log_output | |
| Whether to output DWG2PDF diagnostic logs. More... | |
| export_flags = _fsdk.DWG2PDFSettingData_export_flags | |
| The export flags used for the converted PDF document. Please refer to values starting from FoxitPDFSDKPython3.DWG2PDFSettingData.e_FlagEmbededTTF and this can be one or a combination of these values It could also be 0, which means all bits in the flag are 0. More... | |
| export_hatches_type = _fsdk.DWG2PDFSettingData_export_hatches_type | |
| The type of solid hatches export. More... | |
| frame_block_configuration_path = _fsdk.DWG2PDFSettingData_frame_block_configuration_path | |
| Frame block configuration XML path for frame-block export mode. More... | |
| geometry_output_dpi = _fsdk.DWG2PDFSettingData_geometry_output_dpi | |
| Geometry output DPI setting. More... | |
| gradient_export_hatches_type = _fsdk.DWG2PDFSettingData_gradient_export_hatches_type | |
| The type of gradient hatches export. More... | |
| is_active_layout = _fsdk.DWG2PDFSettingData_is_active_layout | |
| true means to export the active layout only, while false means not. Default value: false. More... | |
| is_output_progress = _fsdk.DWG2PDFSettingData_is_output_progress | |
| A boolean value which indicates whether to output progress logs. true means to output progress logs, and false means not. Default value: true. | |
| layout_index = _fsdk.DWG2PDFSettingData_layout_index | |
| Layout index used when DWG2PDFSettingData::layout_scope is FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLayoutScopeLayoutByIndex . More... | |
| layout_scope = _fsdk.DWG2PDFSettingData_layout_scope | |
| Layout export scope. More... | |
| lineweight_scale_factor = _fsdk.DWG2PDFSettingData_lineweight_scale_factor | |
| Lineweight scale factor. More... | |
| lineweight_style_mode = _fsdk.DWG2PDFSettingData_lineweight_style_mode | |
| Plot lineweight style mode. More... | |
| maximum_drawing_area = _fsdk.DWG2PDFSettingData_maximum_drawing_area | |
| Maximum allowed drawing frame area (unit is millimeters). More... | |
| minimum_export_rect_side_length = _fsdk.DWG2PDFSettingData_minimum_export_rect_side_length | |
| Minimum drawing frame side length used by auto-rectangle export (unit is millimeters). More... | |
| monochrome_image_output_dpi = _fsdk.DWG2PDFSettingData_monochrome_image_output_dpi | |
| Monochrome image output DPI setting. More... | |
| other_export_hatches_type = _fsdk.DWG2PDFSettingData_other_export_hatches_type | |
| The type of other (non-solid) hatches export. More... | |
| output_author = _fsdk.DWG2PDFSettingData_output_author | |
| The author for the output PDF document, an empty string will be used as default. | |
| output_creator = _fsdk.DWG2PDFSettingData_output_creator | |
| The creator for the output PDF document, an empty string will be used as default. | |
| output_keywords = _fsdk.DWG2PDFSettingData_output_keywords | |
| The keywords for the output PDF document, an empty string will be used as default. | |
| output_producer = _fsdk.DWG2PDFSettingData_output_producer | |
| The producer for the output PDF document, an empty string will be used as default. | |
| output_subject = _fsdk.DWG2PDFSettingData_output_subject | |
| The subject for the output PDF document, an empty string will be used as default. | |
| output_title = _fsdk.DWG2PDFSettingData_output_title | |
| The title for the output PDF document, an empty string will be used as default. | |
| page_margin = _fsdk.DWG2PDFSettingData_page_margin | |
| Page margin (unit is millimeters). More... | |
| paper_height = _fsdk.DWG2PDFSettingData_paper_height | |
| The paper height used for the converted PDF document. More... | |
| paper_width = _fsdk.DWG2PDFSettingData_paper_width | |
| The paper width used for the converted PDF document. More... | |
| plot_scale_factor = _fsdk.DWG2PDFSettingData_plot_scale_factor | |
| Plot scale factor. More... | |
| progress_callback = _fsdk.DWG2PDFSettingData_progress_callback | |
| A pointer to a DWG2PDFProgressCallback object which is used to receive the progress of converting DWG to PDF. This parameter can be null. | |
| searchable_text_type = _fsdk.DWG2PDFSettingData_searchable_text_type | |
| The type of search text type. More... | |
| treat_inches_as_millimeters = _fsdk.DWG2PDFSettingData_treat_inches_as_millimeters | |
| Whether to treat inch-based dimensions as millimeters. More... | |
This class represents settings used for converting DWG to PDF. This would be used in class Convert .
|
static |
Background color index in the CAD color palette (range: [0-255]).
Default value: 7. Common indices: 0-black, 1-red, 2-yellow, 3-green, 4-aqua, 5-blue, 6-magenta, 7-white, 8-dark gray. Other values follow the standard CAD color palette definitions. Values outside the range [0-255] are normalized to 7.
|
static |
Color image output DPI setting.
Default value: 400. Valid values are 72, 150, 200, 300, 400, 600 and 1200. Values outside this set are normalized to 400.
|
static |
The color policy used for the converted PDF document.
It use FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFColorPolicyNoPolicy as the default value of this option. Please refer to values starting from FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFColorPolicyNoPolicy and this should be one of these values.
|
static |
The Name of the block reference used to compute drawing scale.
This option is effective only when DWG2PDFSettingData::layout_scope is FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLayoutScopeAutoRects . The block is treated as the drawing frame, and its original size is used to determine a scale factor applied during PDF export. If the specified block does not exist, this option will not take effect.
|
static |
Export configured frame blocks in model space as multiple PDF pages.
|
static |
Bit 12. If enabled, layout geometry will be zoomed to paper size, else layout settings will be applied.
|
static |
Whether to output DWG2PDF diagnostic logs.
Default value is false. false means disabled, and true means enabled.
|
static |
The export flags used for the converted PDF document. Please refer to values starting from FoxitPDFSDKPython3.DWG2PDFSettingData.e_FlagEmbededTTF and this can be one or a combination of these values It could also be 0, which means all bits in the flag are 0.
It use FoxitPDFSDKPython3.DWG2PDFSettingData.e_FlagEmbededTTF as the default value of this option.
|
static |
The type of solid hatches export.
It use FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypePolygons as the default value of this option. Please refer to values starting from FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeBitmap and this should be one of these values.
|
static |
Frame block configuration XML path for frame-block export mode.
This file should contain configured title block names in format:
<?xml version="1.0" encoding="utf-8" ?>
<root> <TitleBlock name="Frame1">
<TitleBlock name="Frame2">
</root>
This option is mainly used when DWG2PDFSettingData::layout_scope is FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLayoutScopeFrameBlocks . The XML file name is not restricted. Empty string means no external frame-block configuration file is used.
|
static |
Geometry output DPI setting.
Default value: 400. Valid values are 72, 150, 200, 300, 400, 600 and 1200. Values outside this set are normalized to 400.
|
static |
The type of gradient hatches export.
For this option, only FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeBitmap and FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeDrawing are supported. It use FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeBitmap as the default value of this option. Please refer to values starting from FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeBitmap and this should be one of these values
|
static |
true means to export the active layout only, while false means not. Default value: false.
|
static |
Layout index used when DWG2PDFSettingData::layout_scope is FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLayoutScopeLayoutByIndex .
The Default value is 1 (the first layout). Values less than 1 are normalized to 1 when using layout by index mode. This option is ignored for other layout scope modes.
|
static |
Layout export scope.
It use FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLayoutScopeCurrentLayout as the default value of this option. Please refer to values starting from FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLayoutScopeModelSpaceOnly . When set to FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLayoutScopeLayoutByIndex , use DWG2PDFSettingData::layout_index to specify the target layout index. If an unsupported value is provided, it is normalized to FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLayoutScopeCurrentLayout mode.
|
static |
Lineweight scale factor.
Default value: 1.0. This option is effective only when DWG2PDFSettingData::lineweight_style_mode is FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLineweightStyleModeStyleAndLineweight . Values less than or equal to 0 are treated as 1.0.
|
static |
Plot lineweight style mode.
It use FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLineweightStyleModeNoStyleNoLineweight as the default value of this option. Please refer to values starting from FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLineweightStyleModeNoStyleNoLineweight . If an unsupported value is provided, an FoxitPDFSDKPython3.e_ErrParam error will be thrown.
|
static |
Maximum allowed drawing frame area (unit is millimeters).
Default value is 0. This option is effective only when DWG2PDFSettingData::layout_scope is FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLayoutScopeAutoRects or FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLayoutScopeAutoRectsAndAllLayouts . If a drawing frame's area exceeds this value, it will be scaled down to fit within the limit. A value of 0 means no limit. Negative values will be treated as 0.
|
static |
Minimum drawing frame side length used by auto-rectangle export (unit is millimeters).
Default value is 0. This option is effective only when DWG2PDFSettingData::layout_scope is FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLayoutScopeAutoRects . In this mode, any drawing frame whose width or height is smaller than this value will be skipped. If this value exceeds the maximum side length of all detected drawing frames, all frames will be skipped. A value of 0 means no limit. Negative values will be treated as 0.
|
static |
Monochrome image output DPI setting.
Default value: 400. Valid values are 72, 150, 200, 300, 400, 600 and 1200. Values outside this set are normalized to 400.
|
static |
The type of other (non-solid) hatches export.
For this option, only FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeBitmap and FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeDrawing are supported. It use FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeBitmap as the default value of this option. Please refer to values starting from FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFExportHatchesTypeBitmap and this should be one of these values
|
static |
Page margin (unit is millimeters).
Default value: 0. Negative values are treated as 0. Values exceeding half of the page size will be set to less than half of the page size.
|
static |
The paper height used for the converted PDF document.
This option can be used if layout geometry will be zoomed to paper size(FoxitPDFSDKPython3.DWG2PDFSettingData.e_FlagZoomToExtentsMode are enabled by export_flags). Effective default value is 297.0f. Unit: millimeters. If this value is less than or equal to 0, it is normalized to 297.0f.
|
static |
The paper width used for the converted PDF document.
This option can be used if layout geometry will be zoomed to paper size(FoxitPDFSDKPython3.DWG2PDFSettingData.e_FlagZoomToExtentsMode are enabled by export_flags). Effective default value is 420.0f. Unit: millimeters. If this value is less than or equal to 0, it is normalized to 420.0f.
|
static |
Plot scale factor.
Default value is 0.99. No strict upper bound is enforced for this value. However, invalid inputs are normalized to maintain stable output. Values less than 0 are normalized to 0.1, and 0 is normalized to 0.99.
|
static |
The type of search text type.
This option can be used if SHX or TTF text exported as geometry(FoxitPDFSDKPython3.DWG2PDFSettingData.e_FlagTTFTextAsGeometry and FoxitPDFSDKPython3.DWG2PDFSettingData.e_FlagSHXTextAsGeometry are enabled by export_flags). It use FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFSearchableTextTypeNoSearch as the default value of this option. Please refer to values starting from FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFSearchableTextTypeNoSearch and this should be one of these values.
|
static |
Whether to treat inch-based dimensions as millimeters.
Default value is false. This option is effective only when the drawing uses inches as its unit and DWG2PDFSettingData::layout_scope is FoxitPDFSDKPython3.DWG2PDFSettingData.e_DWG2PDFLayoutScopeAutoRects . false means disabled, and true means enabled.